List contacts | Payroc | Documentation

Use this method to return a list of contacts for a processing account.

Note: If you want to view the details of a specific contact and you have their contactId, use our Retrieve Contact method.

To list contacts for a processing account, you need the processingAccountId. Our gateway returned the processingAccountId in the response of the Create Merchant Platform method or the Create Processing Account method.

Our gateway returns the following information about each contact:

Name and contact method, including their phone number or mobile number.
Role within the business, for example, if they are a manager.

For each contact, we also return a contactId, which you can use to perform follow-on actions.

Use this method to return a list of contacts for a processing account. **Note:** If you want to view the details of a specific contact and you have their contactId, use our [Retrieve Contact](https://docs.payroc.com/api/schema/boarding/contacts/retrieve) method. To list contacts for a processing account, you need the processingAccountId. Our gateway returned the processingAccountId in the response of the [Create Merchant Platform](https://docs.payroc.com/api/schema/boarding/merchant-platforms/create) method or the [Create Processing Account](https://docs.payroc.com/api/schema/boarding/merchant-platforms/create-processing-account) method. Our gateway returns the following information about each contact: - Name and contact method, including their phone number or mobile number. - Role within the business, for example, if they are a manager. For each contact, we also return a contactId, which you can use to perform follow-on actions.

Path parameters

processingAccountIdstringRequired

Unique identifier that we assigned to the processing account.

Query parameters

beforestringOptional

Return the previous page of results before the value that you specify.

You can’t send the before parameter in the same request as the after parameter.

afterstringOptional

Return the next page of results after the value that you specify.

You can’t send the after parameter in the same request as the before parameter.

limitintegerOptional<=100Defaults to 10

Limit the maximum number of results that we return for each page.

Response

Successful request. Returns a list of contacts associated with the processing account.

countdouble or null

Number of results we returned on this page.

Note: This might not be the total number of results that match your query.

datalist of objects or null

Array of contact objects.

hasMoreboolean or null

Indicates whether there is another page of results available.

limitdouble or null

Maximum number of results that we return for each page.

linkslist of objects or null

Reference links to navigate to the previous page of results or to the next page of results.

Errors