Skip to main content
Get Organization
GET
GET
http://api.atzcrm.com/v1/organization/:slug

Retrieve the details of a specific organization by their unique slug.

Request​

GET

GET /v1/organization/:slug

Path Parameter

  • slugstring

    Replace :slug with the organization's unique slug in the request URL.

Query Parameter

  • Maximizestring

    The maximize parameter allows you to specify which items to maximize in your API response.It is comma separated string values. The following values are allowed:

    • owner
    • created_by
    • updated_by
    • industry

    Note: To maximize all the items in the response, you can pass 'all' as the value for the maximize query parameter.

    Example usage:

    GET /v1/organization/:slug?maximize=owner,industry,all

Response​

200

Body

  • idnumber

    Example: 28

  • slugstring

    Example: organization_d1d6d8323f07a6615f95

  • namestring

    Example: Anjali kotwani

  • websitestring

    Example: google.com

  • locationstring

    Example: indore

  • Addressstring

    Example: pipariya

  • tagsstring

    Example: [leader,java]

  • industryobject

    Example:
    "id": 1,
    "name": "it",

  • descriptionstring

    Example: Experienced software engineer with a focus on frontend development.

  • profile_picturestring

    Example: img.jpg

  • ownerobject

    Example:
    "id": 17"

  • created_atstring (ISO 8601 date)

    Example: 2015-05-15T00:00:00Z

  • updated_atstring (ISO 8601 date)

    Example: 2015-05-15T00:00:00Z

  • created_byobject

    Example:
    "id": 1

  • updated_byobject

    Example:
    "id": 1

  • socialsobject

    Example:
    "linkedin": "anjalilinkedin.com",
    "xing": "anjali.com"

  • custom fields:object

    Example:
    "id": 1,
    "field_name": "textfeild",
    "field_type": "string",
    "value": "anjali"

404

Error

  • Organization does not found

Response Example​

{
    "id": 6,
    "slug": "organization_931819e6d2e065d355ab",
    "name": "TEs contact ",
    "website": "",
    "location": "",
    "address": "",
    "tags": null,
    "industry": null,
    "description": "",
    "profile_picture": "",
    "owner": {
        "id": 1
    },
    "created_at": "2024-05-24T20:06:58.000Z",
    "updated_at": "2024-05-24T20:06:58.000Z",
    "created_by": {
        "id": 1
    },
    "updated_by": {
        "id": 1
    },
    "socials": {
        "linkedin": "",
        "xing": ""
    },
   "custom_fields": [
        {
            "id": 1,
            "field_name": "C Text asasa",
            "field_type": "text",
            "value": "Some custom value"
        },
        {
            "id": 2,
            "field_name": "C Date",
            "field_type": "date",
            "value": null
        }
    ]
}