Get organizations

Get organizations.

get

Query parameters

UserIdstringOptional

The param UserId to apply filter.

CountryCodestringOptional

The param CountryCode to apply filter.

LanguageCodestringOptional

The param LanguageCode to apply filter.

CodestringOptional

The param Code to apply filter.

NamestringOptional

The param Name to apply filter.

DescriptionstringOptional

The param Description to apply filter.

AvatarstringOptional

The param Avatar to apply filter.

IsPrivatebooleanOptional

The param IsPrivate to apply filter.

Statusstring · enumOptional

This enum is used to define the common status of an object in JFW.

Supported values:

• Inactive - In case of JFW object's status being inactive.
• Active - In case of JFW object's status being active

Possible values:

UserStatusstring · enumOptional

The param Status to apply filter. This status is the status of the user in the organization.

Possible values:

KeywordsstringOptional

The param Keywords to apply filter.

SortDataFieldstringOptional

The sort data field to sort. By default, the value is ID.

SortOrderstring · enumOptional

Specifies the sorting order type for a collection.

Possible values:

PageNumberinteger · int32Optional

The page number of the pagination. Default value is 0.

PageSizeinteger · int32Optional

The page size of the pagination. Default value is 200.

Header parameters

Brand-URLstringRequired

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

Example: YOUR_BRAND_URL

Auth-KeystringRequired

Auth-Key is required to authenticate the request. If missing, the server will return 401 Unauthorized.

Example: YOUR_AUTH_KEY

Responses

200

The request was successful.

application/json

The API result model with data.

successbooleanRead-onlyRequired

This is the flag to indicate whether the API call is successful or not.

statusCodeinteger · int32Read-onlyRequired

This is the HTTP status code. This is used to determine the status code to be returned to the client.

messagestring · min: 1Required

This is the message to be displayed to the user.

401

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

application/json

429

API call exceeded rate limit due to too many requests.

application/json

get

/api/v1/organizations

HTTPcURLJavaScriptPython

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

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "items": [
      {
        "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,
        "createdUserId": "admin"
      }
    ],
    "totalItems": 1,
    "pageNumber": 0,
    "pageSize": 10
  },
  "errors": []
}