Browse the docs

Reference · Companies

List companies

GEThttps://api.paygoro.com/v1/companies

Lists the legal entities in the workspace. Most other resources belong to a company; use these ids in `companyId` filters.

Authorization

Requires a bearer API key with companies:read. See Authentication.

Response

200 · application/json

FieldTypeDescription
dataarray of object
idstringOpaque resource id.
namestringRegistered legal name.
tradingNamestring | null
registrationNumberstring | nullChamber of commerce / company registry number.
vatNumberstring | null
countrystring | nullISO 3166-1 alpha-2 country of incorporation.
verificationStatus"NotStarted" | "Pending" | "Verified" | "WaitingForInformation" | "Refused"Know-your-business verification state for the Paygoro business account.
createdAtstring (date-time)Timestamp in RFC 3339 format (UTC).
updatedAtstring (date-time)Timestamp in RFC 3339 format (UTC).

Errors

400BAD_REQUESTThe request was malformed or failed validation.
401UNAUTHORIZEDMissing, malformed, expired or revoked API key.
403FORBIDDENThe API key does not have the scope this operation requires.
404NOT_FOUNDNo resource with this id exists in your workspace, or a `companyId` filter does not match one of your companies.
429TOO_MANY_REQUESTSRate limit exceeded. Retry after the `Retry-After` header.

All errors share one envelope — see Errors.