Pular para o conteúdo principal
GET
Recupere uma lista de objetos de assinatura.

Supported products

Autorizações

Authorization
string
header
obrigatório

The access token received from the authorization server in the OAuth 2.0 flow.

Parâmetros de consulta

after
string

O token do cursor de paginação do último recurso lido será retornado como a propriedade JSON paging.next.after de uma resposta paginada que contém mais resultados.

archived
boolean
padrão:false

Se apenas os resultados que foram arquivados devem ser retornados.

associations
string[]

Uma lista separada por vírgulas de tipos de objeto para recuperar IDs associados. Se alguma das associações especificadas não existir, ela será ignorada.

limit
integer<int32>
padrão:10

O número máximo de resultados a serem exibidos por página.

properties
string[]

Uma lista separada por vírgulas das propriedades a serem retornadas na resposta. Se alguma das propriedades especificadas não estiver presente nos objetos solicitados, ela será ignorada.

propertiesWithHistory
string[]

Uma lista separada por vírgulas das propriedades a serem retornadas junto com seu histórico de valores anteriores. Se alguma das propriedades especificadas não estiver presente nos objetos solicitados, elas serão ignoradas. O uso deste parâmetro reduzirá o número máximo de objetos que podem ser lidos por uma solicitação.

Resposta

successful operation

Representa uma resposta de conjunto paginado que inclui objetos públicos simples com suas associações. Este componente é usado para lidar com os resultados e detalhes de paginação ao recuperar uma lista de objetos da API.

results
object[]
obrigatório

Matriz de SimplePublicObjectWithAssociations, cada um representando um objeto do CRM com propriedades e associações.

paging
object

Informações de paginação para paginação somente para frente. Contém a referência da próxima página quando há mais resultados disponíveis; é omitida ou fica vazia na última página.

Última modificação em 6 de outubro de 2026