Get an organization's details | Close | Developer API Documentation

curl https://api.close.com/api/v1/organization/id/ \
     -u "<CLOSE_API_KEY>:"

{
  "created_by": null,
  "date_created": "2013-02-01T00:54:51.097000+00:00",
  "date_updated": "2013-02-20T04:38:01.961000+00:00",
  "id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
  "inactive_memberships": [],
  "lead_statuses": [
    {
      "id": "stat_1ZdiZqcSIkoGVnNOyxiEY58eTGQmFNG3LPlEVQ4V7Nk",
      "label": "Potential"
    },
    {
      "id": "stat_2ZdiZqcSIkoGVnNOyxiEY58eTGQmFNG3LPlEVQ4V7Nk",
      "label": "Bad Fit"
    },
    {
      "id": "stat_3ZdiZqcSIkoGVnNOyxiEY58eTGQmFNG3LPlEVQ4V7Nk",
      "label": "Qualified"
    }
  ],
  "memberships": [
    {
      "auto_record_calls": "unset",
      "id": "memb_wLKueFux8M2u2jshQPichvA5V44hpECtoljWbJS1PeY",
      "permissions_granted": [
        "bulk_edit",
        "export"
      ],
      "role_id": "role_y6eLquXvRUdmwqi61tsmgCJUU7uGfxaRbDuLoONZL9p",
      "track_email_opens": true,
      "user_email": "phil+sample@close.com",
      "user_first_name": "P",
      "user_full_name": "John Doe",
      "user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
      "user_last_name": "F",
      "user_phone": "16502822245"
    },
    {
      "auto_record_calls": "unset",
      "id": "memb_hLHF3LsUI6N7twH1derRHiHEKeE843ttSYmsun4xkCn",
      "permissions_granted": [
        "bulk_edit",
        "export"
      ],
      "role_id": "role_y6eLquXvRUdmwqi61tsmgCJUU7uGfxaRbDuLoONZL9p",
      "track_email_opens": true,
      "user_email": "phil@close.com",
      "user_first_name": "Phil",
      "user_full_name": "Phil Freo",
      "user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
      "user_last_name": "Freo",
      "user_phone": "16502822248"
    },
    {
      "auto_record_calls": "unset",
      "id": "memb_I4Tx9tZwz5npqdGtd0baWtjjlpeFf45OBlkAAKcF3Gc",
      "permissions_granted": [
        "bulk_edit",
        "export"
      ],
      "role_id": "role_y6eLquXvRUdmwqi61tsmgCJUU7uGfxaRbDuLoONZL9p",
      "track_email_opens": true,
      "user_email": "anthony@close.com",
      "user_first_name": "Anthony",
      "user_full_name": "Anthony Nemitz",
      "user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
      "user_last_name": "Nemitz",
      "user_phone": "16502822249"
    }
  ],
  "name": "Sample Data",
  "pipelines": [
    {
      "created_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
      "date_created": "2019-11-04T11:04:13.014979",
      "date_updated": "2019-11-13T14:12:13.051542",
      "id": "pipe_6gV01if4wo7r2YTVQDWP2j",
      "name": "Sales",
      "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
      "statuses": [
        {
          "id": "stat_3PB2sedHBCjwuBImAEwgHOo858f2j41lpROkcl51Fzp",
          "label": "Active",
          "type": "active"
        },
        {
          "id": "stat_IOCtLYbAclJ8XAcb3yLUhQA3zlmjtXz8JMBLyXnNMF8",
          "label": "Won",
          "type": "won"
        },
        {
          "id": "stat_3mmBOyMmaG8yc4DmAPp9WmgbjhVctVLlnd9gmvWxBe2",
          "label": "Lost",
          "type": "lost"
        }
      ],
      "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA"
    }
  ],
  "plan_type": "lite",
  "updated_by": null
}

curl https://api.close.com/api/v1/organization/id/ \
     -u "<CLOSE_API_KEY>:"

{
  "created_by": null,
  "date_created": "2013-02-01T00:54:51.097000+00:00",
  "date_updated": "2013-02-20T04:38:01.961000+00:00",
  "id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
  "inactive_memberships": [],
  "lead_statuses": [
    {
      "id": "stat_1ZdiZqcSIkoGVnNOyxiEY58eTGQmFNG3LPlEVQ4V7Nk",
      "label": "Potential"
    },
    {
      "id": "stat_2ZdiZqcSIkoGVnNOyxiEY58eTGQmFNG3LPlEVQ4V7Nk",
      "label": "Bad Fit"
    },
    {
      "id": "stat_3ZdiZqcSIkoGVnNOyxiEY58eTGQmFNG3LPlEVQ4V7Nk",
      "label": "Qualified"
    }
  ],
  "memberships": [
    {
      "auto_record_calls": "unset",
      "id": "memb_wLKueFux8M2u2jshQPichvA5V44hpECtoljWbJS1PeY",
      "permissions_granted": [
        "bulk_edit",
        "export"
      ],
      "role_id": "role_y6eLquXvRUdmwqi61tsmgCJUU7uGfxaRbDuLoONZL9p",
      "track_email_opens": true,
      "user_email": "phil+sample@close.com",
      "user_first_name": "P",
      "user_full_name": "John Doe",
      "user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
      "user_last_name": "F",
      "user_phone": "16502822245"
    },
    {
      "auto_record_calls": "unset",
      "id": "memb_hLHF3LsUI6N7twH1derRHiHEKeE843ttSYmsun4xkCn",
      "permissions_granted": [
        "bulk_edit",
        "export"
      ],
      "role_id": "role_y6eLquXvRUdmwqi61tsmgCJUU7uGfxaRbDuLoONZL9p",
      "track_email_opens": true,
      "user_email": "phil@close.com",
      "user_first_name": "Phil",
      "user_full_name": "Phil Freo",
      "user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
      "user_last_name": "Freo",
      "user_phone": "16502822248"
    },
    {
      "auto_record_calls": "unset",
      "id": "memb_I4Tx9tZwz5npqdGtd0baWtjjlpeFf45OBlkAAKcF3Gc",
      "permissions_granted": [
        "bulk_edit",
        "export"
      ],
      "role_id": "role_y6eLquXvRUdmwqi61tsmgCJUU7uGfxaRbDuLoONZL9p",
      "track_email_opens": true,
      "user_email": "anthony@close.com",
      "user_first_name": "Anthony",
      "user_full_name": "Anthony Nemitz",
      "user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
      "user_last_name": "Nemitz",
      "user_phone": "16502822249"
    }
  ],
  "name": "Sample Data",
  "pipelines": [
    {
      "created_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
      "date_created": "2019-11-04T11:04:13.014979",
      "date_updated": "2019-11-13T14:12:13.051542",
      "id": "pipe_6gV01if4wo7r2YTVQDWP2j",
      "name": "Sales",
      "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
      "statuses": [
        {
          "id": "stat_3PB2sedHBCjwuBImAEwgHOo858f2j41lpROkcl51Fzp",
          "label": "Active",
          "type": "active"
        },
        {
          "id": "stat_IOCtLYbAclJ8XAcb3yLUhQA3zlmjtXz8JMBLyXnNMF8",
          "label": "Won",
          "type": "won"
        },
        {
          "id": "stat_3mmBOyMmaG8yc4DmAPp9WmgbjhVctVLlnd9gmvWxBe2",
          "label": "Lost",
          "type": "lost"
        }
      ],
      "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA"
    }
  ],
  "plan_type": "lite",
  "updated_by": null
}

By default, memberships and inactive_memberships are populated with user data prefixed with user_. If you’d rather have a nested user field, use a query string like ?_expand=memberships__user,inactive_memberships__user.

Authentication

AuthorizationBasic

Use your API key as the username and leave the password empty.

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired

Query parameters

_expandstringOptional

Response

Successful response

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

$	curl https://api.close.com/api/v1/organization/id/ \
>	-u "<CLOSE_API_KEY>:"

1	{
2	"created_by": null,
3	"date_created": "2013-02-01T00:54:51.097000+00:00",
4	"date_updated": "2013-02-20T04:38:01.961000+00:00",
5	"id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
6	"inactive_memberships": [],
7	"lead_statuses": [
8	{
9	"id": "stat_1ZdiZqcSIkoGVnNOyxiEY58eTGQmFNG3LPlEVQ4V7Nk",
10	"label": "Potential"
11	},
12	{
13	"id": "stat_2ZdiZqcSIkoGVnNOyxiEY58eTGQmFNG3LPlEVQ4V7Nk",
14	"label": "Bad Fit"
15	},
16	{
17	"id": "stat_3ZdiZqcSIkoGVnNOyxiEY58eTGQmFNG3LPlEVQ4V7Nk",
18	"label": "Qualified"
19	}
20	],
21	"memberships": [
22	{
23	"auto_record_calls": "unset",
24	"id": "memb_wLKueFux8M2u2jshQPichvA5V44hpECtoljWbJS1PeY",
25	"permissions_granted": [
26	"bulk_edit",
27	"export"
28	],
29	"role_id": "role_y6eLquXvRUdmwqi61tsmgCJUU7uGfxaRbDuLoONZL9p",
30	"track_email_opens": true,
31	"user_email": "phil+sample@close.com",
32	"user_first_name": "P",
33	"user_full_name": "John Doe",
34	"user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
35	"user_last_name": "F",
36	"user_phone": "16502822245"
37	},
38	{
39	"auto_record_calls": "unset",
40	"id": "memb_hLHF3LsUI6N7twH1derRHiHEKeE843ttSYmsun4xkCn",
41	"permissions_granted": [
42	"bulk_edit",
43	"export"
44	],
45	"role_id": "role_y6eLquXvRUdmwqi61tsmgCJUU7uGfxaRbDuLoONZL9p",
46	"track_email_opens": true,
47	"user_email": "phil@close.com",
48	"user_first_name": "Phil",
49	"user_full_name": "Phil Freo",
50	"user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
51	"user_last_name": "Freo",
52	"user_phone": "16502822248"
53	},
54	{
55	"auto_record_calls": "unset",
56	"id": "memb_I4Tx9tZwz5npqdGtd0baWtjjlpeFf45OBlkAAKcF3Gc",
57	"permissions_granted": [
58	"bulk_edit",
59	"export"
60	],
61	"role_id": "role_y6eLquXvRUdmwqi61tsmgCJUU7uGfxaRbDuLoONZL9p",
62	"track_email_opens": true,
63	"user_email": "anthony@close.com",
64	"user_first_name": "Anthony",
65	"user_full_name": "Anthony Nemitz",
66	"user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
67	"user_last_name": "Nemitz",
68	"user_phone": "16502822249"
69	}
70	],
71	"name": "Sample Data",
72	"pipelines": [
73	{
74	"created_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
75	"date_created": "2019-11-04T11:04:13.014979",
76	"date_updated": "2019-11-13T14:12:13.051542",
77	"id": "pipe_6gV01if4wo7r2YTVQDWP2j",
78	"name": "Sales",
79	"organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
80	"statuses": [
81	{
82	"id": "stat_3PB2sedHBCjwuBImAEwgHOo858f2j41lpROkcl51Fzp",
83	"label": "Active",
84	"type": "active"
85	},
86	{
87	"id": "stat_IOCtLYbAclJ8XAcb3yLUhQA3zlmjtXz8JMBLyXnNMF8",
88	"label": "Won",
89	"type": "won"
90	},
91	{
92	"id": "stat_3mmBOyMmaG8yc4DmAPp9WmgbjhVctVLlnd9gmvWxBe2",
93	"label": "Lost",
94	"type": "lost"
95	}
96	],
97	"updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA"
98	}
99	],
100	"plan_type": "lite",
101	"updated_by": null
102	}