Get an organization

Gets an organization by the given id.

get

Path parameters

idstringRequired

The organization id.

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Auth-KeystringRequired

This is used to authenticate the request. If the request is not authenticated, the server will return a 401 Unauthorized response.

Example: YOUR_AUTH_KEY

Responses

200

The request was successful.

application/json

401

The user is not authorized to access the requested resource. The request is missing the required Auth-Key header.

application/json

404

The Organization was not found in the system.

application/json

429

The user has exceeded the rate limit.

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/organizations/{id} HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Accept: */*

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "id": "sApKpllz4sAplsmzha",
    "code": "DFEC4E7907500C92CD259BB3755C1810",
    "name": "ORG",
    "languageCode": "en",
    "countryCode": "US",
    "avatar": "https://jfw.io/avatar.png",
    "isDefault": true,
    "isPrivate": false,
    "isSystem": false,
    "description": "JFW Organization",
    "status": "Active",
    "statusUser": "Joined",
    "totalMembers": 1,
    "createdBy": "admin"
  },
  "errors": []
}