v1

latestOpenAPI 3.1.02026-07-2438302.6 MB

Get Organizations

get/organization

Query parameters

pageinteger

Page number to fetch

countinteger

Number of organizations in the page

sort'DESC' | 'ASC'

Sort order

sort_by'organization_name' | 'created_at'

Sort type

filter.keywordstring

Keyword search based on organization name and email

filter.is_activeboolean

Filter by active organizations

filter.teamsstring[]

Filter by organization teams UIDs

filter.updated_at_fromstring date

Filter by organization updated date from

filter.updated_at_tostring date

Filter by organization updated date to

filter.is_portal_enabledboolean

Filter by portal enabled organizations

filter.custom_fieldobject

Filter by organization's custom field

filter.organization_uidstring

Filter by organization uid

filter.is_deletedboolean

Filter by deleted organizations

Response

200

typestring

total_recordsinteger

current_pageinteger

total_pagesinteger

Example response

{
  "type": "success",
  "data": [
    {
      "organization_uid": "219cf1e0-5ba1-11ee-8cd0-516f5d67130d",
      "organization_name": "Test API docs",
      "organization_description": "<p>test</p>",
      "organization_email": "velu.k24@gmail.com",
      "no_of_customers": 1,
      "organization_address": {
        "city": "Chennai ",
        "state": "Tamil Nadu ",
        "street": "Zupersoft Solutions Private Limited, Rajiv Gandhi Salai, Elango Nagar, OMR",
        "country": "India",
        "landmark": "tt",
        "geo_cordinates": [
          12.9729347
        ]
      },
      "organization_billing_address": {
        "city": "Chennai ",
        "state": "Tamil Nadu ",
        "street": "Zupersoft Solutions Private Limited, Rajiv Gandhi Salai, Elango Nagar, OMR",
        "country": "India",
        "landmark": "tt",
        "geo_cordinates": [
          12.9729347
        ]
      },
      "created_by": {
        "user_uid": "cfa78be2-b427-4d5a-89fe-7cf4a8e01352",
        "first_name": "velmurugan",
        "last_name": "k",
        "email": "velmurugan.k@zuper.co",
        "home_phone_number": "9600086457",
        "designation": "Admin",
        "emp_code": "001",
        "work_phone_number": "9600086457",
        "is_active": true,
        "created_at": "2022-11-03T11:33:22.000Z",
        "updated_at": "2022-11-03T11:33:22.000Z"
      },
      "is_active": true,
      "created_at": "2023-09-25T12:43:30.690Z",
      "updated_at": "2023-09-25T12:43:30.696Z"
    }
  ],
  "total_records": 10,
  "current_page": 1,
  "total_pages": 2
}