Qodex.ai

Retrieving all contact assignments

GET {{api-url}}/customer-management/{{tenant}}/contact-assignments?pageNumber=1&pageSize=16&sort=name,metadata.createdAt:desc&legalEntity.id=proident&contact.id=proident&type=PRIMARY&primary=true

Preview Retrieves all contact assignments assigned to the tenant. You can filter, sort and paginate the results with query parameters.

### Required scopes * clientmanagement.contactassignment_read

Request Params

KeyDatatypeRequiredDescription
pageNumbernumberThe page number to be retrieved where the size of the pages must be specified by the pageSize parameter.
The number of the first page is 1.
pageSizenumberThe number of documents being retrieved on the page.
sortstringFields to sort the response data by following order of the parameters from left to right. Can contain multiple fields in format: field name:sort direction separated by a comma. The colon with sort direction parameter is redundant and descending order is taken only if it is equal to desc or DESC. Ascending order is considered in any other case.
legalEntity.idstringThe id of the legal entity. When specified, only contact assignments attached to the specified legal entity will be returned.

Note: When filtering the results with this field, the equals operator is used. | | contact.id | string | | The id of the contact. When specified, only contact assignments attached to the specified contact will be returned.

Note: When filtering the results with this field, the equals operator is used. | | type | string | | The type of the contact assignment. When specified, only contact assignments with the specified type will be returned.

Note: When filtering the results with this field, the equals operator is used. | | primary | boolean | | The primary contact flag. When specified, only contacts with the specified primary flag value will be returned.

Note: When filtering the results with this field, the equals operator is used. |

HEADERS

KeyDatatypeRequiredDescription
X-Total-CountbooleanIn order to get information how many entities meet a filter requirements, X-Total-Count header has been introduced. The header is optional and its default value is false. It the header is provided and it is true then total count is returned in the X-Total-Count response header. In both cases (X-Total-Count true, false or not provided), the response body has the same format (array of entities). In other words, the information about total count is returned on demand, depending of an existence of X-Total-Count header in a request. Therefore, the X-Total-Count header is not returned if an API consumer didn’t ask for it.
Acceptstring

RESPONSES

status: OK

[{"id":"627e06ecf0452c2d6c0b81391","legalEntity":{"id":"123e06ecf0452c2d6c0b12391","name":"Subsidiary name","type":"SUBSIDIARY","parentId":"627e06ecf0452c2d6c0b81391","accountLimit":1000.99,"legalInfo":{"legalName":"Some subsidiary name","registrationDate":"2022-03-31T13:18:02.379Z","taxRegistrationNumber":4311,"registrationAgency":"Sub reg agency","countryOfRegistration":"DE","registrationId":"627e06ecf0452c2d6c0b81399"},"customerGroups":[{"id":"123e06ecf0452c2d6c0b81390","name":{"en":"Customer group 1","fr":"Groupe de clients 1"}}]},"contact":{"id":"627e06ecf0452c2d6c0b81391","name":"John","surname":"Doe","customer":{"id":"john-doe-customer","name":"JohnCustomer","surname":"DoeCustomer"},"contactDetails":{"emails":["jon.doe@example.com","adam.smith@sample.org"],"phones":[1234567890,"0123456789"],"addressLine1":"W Sample St","addressLine2":"3601-3799","city":"South Bend","state":"Indiana","postcode":46619,"countryCode":"US"},"metadata":{"createdAt":"2022-03-31T13:18:02.379Z","modifiedAt":"2022-03-31T13:18:02.379Z","version":1}},"type":"BILLING","primary":true,"metadata":{"createdAt":"2022-03-31T13:18:02.379Z","modifiedAt":"2022-03-31T13:18:02.379Z","version":1}},{"id":"627e06ecf0452c2d6c0b81311","legalEntity":{"id":"123e06ecf0452c2d6c0b81390","name":"Company name","type":"COMPANY","legalInfo":{"legalName":"Some company name","registratonDate":"2022-03-31T13:18:02.379Z","registrationAgency":"Comp reg agency","registrationId":"627e06ecf0452c2d6c0b81391","countryOfRegistration":"DE","taxRegistrationNumber":"1234","accountLimit":1000.99},"customerGroups":[{"id":"123e06ecf0452c2d6c0b81390","name":{"en":"Customer group 1","fr":"Groupe de clients 1"}},{"id":"123e06ecf0452c2d6c0b12345","name":{"en":"Customer group 2","fr":"Groupe de clients 2"}}],"entitiesAddresses":[{"id":"123e123455452c2d6c0b81390"},{"id":"123e06ecf0acd223140b12345"}],"documents":[{"id":"123e121111452c2d6c0b81390"},{"id":"123e06ecf0acd223133333345"}],"approvalGroup":[{"id":"627e06ecf0452c2d6c0b81391","name":"John","surname":"Doe","contactDetails":{"emails":["jon.doe@example.com","adam.smith@sample.org"],"phones":[1234567890,"0123456789"],"addressLine1":"W Sample St","addressLine2":"3601-3799","city":"South Bend","state":"Indiana","postcode":46619,"countryCode":"US"},"metadata":{"createdAt":"2022-03-31T13:18:02.379Z","modifiedAt":"2022-03-31T13:18:02.379Z","version":1}},{"id":"123e06ecf0452c2d6c0b81390","name":"Adam","surname":"Smith","contactDetails":{"emails":["adam.klein@email.com","dirk.davis@mail.org"],"phones":[6475837467,"0987654321"],"addressLine1":"Dircksenstraße","addressLine2":136,"city":"Berlin","state":"Berlin","postcode":10178,"countryCode":"DE"},"metadata":{"createdAt":"2022-04-31T13:18:02.379Z","modifiedAt":"2022-05-31T13:18:02.379Z","version":2}}],"metadata":{"createdAt":"2022-03-31T13:18:02.379Z","modifiedAt":"2022-03-31T13:18:02.379Z","version":1}},"contact":{"id":"627e06ecf0452c2d6c0b81391","name":"John","surname":"Doe","customer":{"id":"john-doe-customer","name":"JohnCustomer","surname":"DoeCustomer"},"contactDetails":{"emails":["jon.doe@example.com","adam.smith@sample.org"],"phones":[1234567890,"0123456789"],"addressLine1":"W Sample St","addressLine2":"3601-3799","city":"South Bend","state":"Indiana","postcode":46619,"countryCode":"US"},"metadata":{"createdAt":"2022-03-31T13:18:02.379Z","modifiedAt":"2022-03-31T13:18:02.379Z","version":1}},"type":"PRIMARY","primary":false,"metadata":{"createdAt":"2022-04-31T13:18:02.379Z","modifiedAt":"2022-05-31T13:18:02.379Z","version":2}}]