Skip to main content

GET All Organizations

Overview


The following table contains important information about the GET method in regards to receiving all organizations.

GET All Organization
MethodGET
URL or Endpoint/api/organizations
ParametersNone
BodyNone

Request Body

The request does not contain a request body

Response

{
"success": true,
"errors": ["string"],
"messages": ["string"],
"result": {
"publicId": "string",
"isDefault": true,
"name": "string",
"addressLine1": "string",
"addressLine2": "string",
"state": "string",
"country": "string",
"city": "string",
"vatNumber": "string"
},
"resultInfo": "string",
"statusCode": 0
}

Information about the fields that appear when you receive the response are displayed in the table below.

Field NameTypeDescription
successboolIf the response is successful it will return true. Otherwise will return false
errorsarray[string]Indicates if there was an error
messagesarray[string]Returns the response message from back-end
resultarray[Object]Returns the response object
publicIdstringThe public ID of your organization.
isDefaultboolIndicates whether the organization is the default organization.
addressLine1YesstringThe first address line of your organization.
addressLine2YesstringThe second address line of your organization.
stateYesstringThe state of your organization.
countryYesstringThe country of your organization.
cityYesstringThe city of your organization.
vatNumberYesstringThe VAT number of your organization.
resultInfostringReturns extra information about the result
statusCodeinteger($int32)Returns the HTTP Status Code

If the action is successful, the service sends back an HTTP 200 or 201 response.

Errors

For information about the errors that are common to all actions, see Common Errors:

  • HTTP Status Code 400: Bad Request

  • HTTP Status Code 401: Unauthorized

  • HTTP Status Code 403: Forbidden

  • HTTP Status Code 404: Result Not Found

  • HTTP Status Code 500: Internal Server Error

  • HTTP Status Code 503: Backend Fetch Failed