Get Organizations by User Type

Retrieves a list of organizations filtered by the specified user type. Useful for clients needing to fetch organizations relevant to a particular user classification, such as ENTERPRISE_API.

HTTP Method and URL

Method: GET
URL: {{host}}/api/v2/organizations?user_type=ENTERPRISE_API

Authentication Requirements

Requires a valid authentication token. The token should be included in the request headers as a Bearer token or as specified by your API's authentication scheme.

Path and Query Parameters

• Query Parameter:
  • user_type (string, required): The type of user to filter organizations by. Example: ENTERPRISE_API.

Request Body

None. This endpoint does not accept a request body.

Example Request

GET {{host}}/api/v2/organizations?user_type=ENTERPRISE_API
Authorization: Bearer <user-token>

Example Successful Response

{
  "organizations": [
    {
      "id": "org_12345",
      "name": "Acme Corporation",
      "type": "ENTERPRISE_API",
      "created_at": "2023-01-01T12:00:00Z",
      "updated_at": "2023-06-01T08:30:00Z"
    },
    {
      "id": "org_67890",
      "name": "Beta Inc.",
      "type": "ENTERPRISE_API",
      "created_at": "2023-02-15T09:45:00Z",
      "updated_at": "2023-06-10T14:20:00Z"
    }
  ]
}

Error Responses

• 400 Bad Request: Missing or invalid user_type parameter.

• 401 Unauthorized: Authentication token is missing or invalid.

• 500 Internal Server Error: Unexpected server error.

Usage Notes

• The user_type parameter is required and must be a valid value such as ENTERPRISE_API or DOC_API.

• The response contains an array of organization objects, each with id, name, type, created_at, and updated_at fields.

• Ensure your authentication token is current and has the necessary permissions to access organization data.