Get contacts linked to a card

Returns all contacts linked to a card via its person or persons fields.

Results are the distinct union of contacts across all person/persons fields on the card. Returns an empty array if the board has no person fields or none are populated on this card.

GET /api/board/{boardId}/{cardId}/contacts

Get contacts linked to a card

cURL

curl --request GET \
  --url https://core-api.getaptly.com/api/board/{boardId}/{cardId}/contacts \
  --header 'x-token: <api-key>'

200

{
  "data": [
    {
      "_id": "abc123",
      "firstname": "Jane",
      "lastname": "Smith",
      "fullname": "Jane Smith",
      "email": [
        "[e-mail]"
      ],
      "phone": [
        {
          "number": "[phone]",
          "type": "mobile"
        }
      ]
    }
  ]
}

Authorizations

x-token · string · header · required

Path Parameters

boardId · string · required

cardId · string · required

Response

200

application/json

List of linked contacts.

data · object[]

Show child attributes