GET Organization's Details

Overview

---

The following table contains important information about the GET method in regards to receiving an organization's details.

GET Organization's Details
Method	GET
URL or Endpoint	/api/organizations/organizationId
Parameters	organizationId
Body	None

The description of the URL parameter is as follows:

URL Parameter Name	Mandatory	Type	Description
organizationId	Yes	string	Unique Id of the organization.

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 Name	Type	Description
success	bool	If the response is successful it will return true. Otherwise will return false
errors	array[string]	Indicates if there was an error
messages	array[string]	Returns the response message from back-end
result	array[Object]	Returns the response object
publicId	string	The public ID of your organization.
isDefault	bool	Indicates whether the organization is the default organization.
addressLine1	Yes	string	The first address line of your organization.
addressLine2	Yes	string	The second address line of your organization.
state	Yes	string	The state of your organization.
country	Yes	string	The country of your organization.
city	Yes	string	The city of your organization.
vatNumber	Yes	string	The VAT number of your organization.
resultInfo	string	Returns extra information about the result
statusCode	integer($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