Get contacts

GET

/v2/accounts/:accountId/contacts/:contactId

GET

/restapi/v2/accounts/:accountId/contacts/:contactId

curl https://demo.docusign.net/restapi/v2/accounts/accountId/contacts/contactId \
     -H "Authorization: <apiKey>"

{
  "contacts": [
    {
      "contactId": "string",
      "contactPhoneNumbers": [
        {
          "phoneNumber": "string",
          "phoneType": "string"
        }
      ],
      "contactUri": "string",
      "emails": [
        "string"
      ],
      "errorDetails": {
        "errorCode": "string",
        "message": "string"
      },
      "name": "string",
      "organization": "string",
      "shared": "string",
      "signingGroup": "string",
      "signingGroupName": "string"
    }
  ],
  "endPosition": "string",
  "nextUri": "string",
  "previousUri": "string",
  "resultSetSize": "string",
  "startPosition": "string",
  "totalSetSize": "string"
}

Authentication

Authorizationstring

OAuth 2.0 access token (JWT or auth-code grant). Sent as Authorization: Bearer <token>.

Path parameters

accountIdstringRequired

The external account number (int) or account id GUID.

contactIdstringRequired

The unique identifier of a person in the contacts address book.

Response

Successful response.

contactslist of objectsOptional

endPositionstringOptional

The last position in the result set.

nextUristringOptional

The URI for the next chunk of records based on the search request. It is null if this is the last set of results for the search.

previousUristringOptional

The URI for the prior chunk of records based on the search request. It is null if this is the first set of results for the search.

resultSetSizestringOptional

The number of results returned in this response.

startPositionstringOptional

Starting position of the current result set.

totalSetSizestringOptional

The total number of items in the search’s result set. It will always be greater than or equal to the value of the resultSetSize field.

Errors

400

Bad Request Error