Methods List - BYTEHAND

SMS

Payments

Documents

BYTEHAND API v2 Getting Started Authorization

Access Rights

Methods List

Objects List

Search Queries Error Processing

View contact lists and their properties.

Method	Description
queryContactLists	GET /contact_lists Returns lists of contacts that match the query. This method supports the semantics of search queries. Requires authorization and access right contacts_view.
queryContactListsCount	HEAD /contact_lists Returns the number of contact lists that match the query. This method supports the semantics of search queries. Requires authorization and access right contacts_view.
queryContactListsV1	GET /contact_lists/v1 Returns legacy contact lists that match the query. This method supports the semantics of search queries. Requires authorization and access right contacts_view.
queryContactListsCountV1	HEAD /contact_lists/v1 Returns the number of legacy contact lists that match the query. This method supports the semantics of search queries. Requires authorization and access right contacts_view.
getContactListV1ById	GET /contact_lists/v1/listId Returns contact lists in legacy format. Requires authorization and access right contacts_view.
getContactListById	GET /contact_lists/listId Returns a contact list by its ID. Requires authorization and access right contacts_view.
queryContactListContacts	GET /contact_lists/listId/contacts Returns the contacts and contact list that match the query. This method supports the semantics of search queries. Requires authorization and access right contacts_view.
queryContactListContactsCount	HEAD /contact_lists/listId/contacts Returns the number of contacts from the contact list that match the query. This method supports the semantics of search queries. Requires authorization and access right contacts_view.
getContactListContactById	GET /contact_lists/listId/contacts/contactId Returns a contact in the contact list by its ID. Requires authorization and access right contacts_view.
getContactListProperties	GET /contact_lists/listId/properties Returns the fields in the contact list. Requires authorization and access right contacts_view.
getContactListPropertyById	GET /contact_lists/listId/properties/propertyId Returns a field in the contact list by its ID. Requires authorization and access right contacts_view.
getContactListSegments	GET /contact_lists/listId/segments Returns the segments in the contact list. Requires authorization and access right contacts_view.
getContactListSegmentById	GET /contact_lists/listId/segments/segmentId Returns a segment in the contact list by its ID. Requires authorization and access right contacts_view.

Need help? Visit our support page