Skip to main content

addressesByCompanyId

Retrieve addresses associated with a specific company.

Returns all addresses linked to the specified company including headquarters, branch offices, shipping locations, and billing addresses. Used for B2B operations and company management.

Possible errors:

  • ADDRESS_RESPONSE_ERROR: Failed to retrieve company addresses from the backend service
  • ADDRESS_UNKNOWN_ERROR: Unknown error occurred during address retrieval
  • FORBIDDEN: Insufficient permissions to access company addresses

AUTH: Role=[user.OWNER,user.EDITOR,user.VIEWER] OR (('user is authenticated') AND ('companyId(s) if present in input matches JWT'))

addressesByCompanyId(
  companyId: Float!
  type: AddressType
): [Address!]!

Arguments​

addressesByCompanyId.companyId ● Float! non-null scalar​

Unique identifier of the company.

Must be a positive integer representing a valid company ID in the system.

addressesByCompanyId.type ● AddressType enum​

Filter addresses by type.

When provided, returns only addresses of the specified type (e.g., headquarters, branch, shipping). If omitted, returns all address types.

Type​

Address object​