Class Organizations

searchIterator

let page = 0
for await (const entries of affinity.organizations.searchIterator({
    term: 'Ltd',
    page_size: 10
})) {
    console.log(`Page ${++page} of entries:`, entries)
}
Copy

create

• create(data): Promise<SimpleOrganizationResponse>

• Creates a new organization with the supplied parameters.

  Parameters

  • data: CreateOrganizationRequest

    Object containing the data for creating a new organization

  Returns Promise<SimpleOrganizationResponse>

  The organization resource that was just created.

  Example

  const newOrganization = await affinity.organizations.create({
      name: 'Acme Corporation',
      domain: 'acme.co',
      person_ids: [38706]
  })
  console.log(newOrganization)
  Copy

delete

• delete(request): Promise<boolean>

• Deletes an organization with a specified organization_id.

  Parameters

  • request: OrganizationReference

  Returns Promise<boolean>

  true if the deletion was successful

  Example

  const success = await affinity.organizations.delete({
      organization_id: 12345
  })
  console.log(success ? 'Organization deleted': 'Organization not deleted')
  Copy

get

• get(params): Promise<SingleOrganizationResponse>

• Fetches an organization with a specified organization_id.

  Parameters

  • params: GetOrganizationRequest

  Returns Promise<SingleOrganizationResponse>

  The organization object corresponding to the organization_id.

  Example

  const organization = await affinity.organizations.get({
      organization_id: 12345
  })
  console.log(organization)
  Copy

getFields

• getFields(): Promise<EntityField[]>

• Fetches an array of all the global fields that exist on organizations.

  Returns Promise<EntityField[]>

  An array of the fields that exist on all organizations for your team.

  Example

  const organizationFields = await affinity.organizations.getFields()
  console.log(organizationFields)
  Copy

search

• search(request): Promise<PagedOrganizationResponse>

• Searches your team's data and fetches all the organizations that meet the search criteria.

  Parameters

  • request: SearchOrganizationsRequest

    Object containing the data for the request

  Returns Promise<PagedOrganizationResponse>

  Example

  const result = await affinity.organizations.search({
      term: 'affinity'
  })
  console.log(result.organizations)
  Copy

update

• update(data): Promise<SimpleOrganizationResponse>

• Updates an existing organization with organization_id with the supplied parameters.

  Parameters

  • data: UpdateOrganizationRequest

    Object containing the data for updating an organization

  Returns Promise<SimpleOrganizationResponse>

  The organization resource that was just updated.

  Example

  const updatedOrganization = await affinity.organizations.update({
      organization_id: 12345,
      name: 'Acme Corp.',
      person_ids: [38706, 89734]
  })
  console.log(updatedOrganization)
  Copy