Documentación
Ir a AlegraForoNovedadesContactoX/Twitter

Listado de sucursales de un contacto

get
https://api.alegra.com/api/v1/contacts//branch-offices
📘

Disponible solo para Colombia

Las sucursales solo están habilitadas para compañías con versión Colombia.

Endpoint que permite consultar las sucursales registradas para un contacto específico

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

ID del contacto para obtener sus sucursales

Query Params
integer
Defaults to 0

Índice de inicio para paginación

integer
≤ 100
Defaults to 30

Número máximo de registros a devolver (máximo 100)

string
enum
Defaults to name

Campo por el cual ordenar los resultados

Allowed:
string
enum
Defaults to ASC

Dirección del ordenamiento

Allowed:
string
enum

Filtro por estado de la sucursal

Allowed:
string

Filtro por nombre de sucursal (búsqueda parcial)

string

Búsqueda general en múltiples campos

boolean
Defaults to false

Incluir metadatos en la respuesta (conteo total)

Responses

Updated about 21 hours ago

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 21 hours ago