AliaDocsSign in
Sign in

Get your integration and agencies

Returns the integration your API key belongs to, the agencies it may access and its scopes. Call it first: every other path needs the id of one of these agencies.

GEThttps://api.alia.cx/api/v1/me

Responses

200OKYour integration, agencies and scopes.
  • integrationobjectRequired

    The integration your API key belongs to.

    Show 2 child fields
    • idstringRequired

      Integration id.

    • namestringRequired

      Integration name.

  • agenciesarray of objectsRequired

    Agencies your key may access, sorted by name.

    Show 2 child fields
    • idstringRequired

      Agency ID. Use it as agencyId in paths. It never changes.

    • namestring or nullRequired

      Agency name. Null when the agency has no name set.

  • scopesarray of stringsRequired

    Actions your key may take.

Errors

  • 401UnauthorizedPartnerUnauthorizedThe bearer token is missing or not valid.
  • 403ForbiddenPartnerForbiddenThe key may not do this.
  • 404Not foundPartnerNotFoundNot found.
  • 500Server errorPartnerInternalErrorAlia failed to handle the request.

Every error body is JSON with the same two fields: _tag names the error and message explains it. How errors work

Basics

Base URL, authentication, errors, and pagination for every endpoint.

List conversationsGET

Lists the agency's WhatsApp conversations, newest last message first. Pass nextCursor as cursor to read the next page; stop when nextCursor is null.