BlueForge Docs

client.org.get

Get an organisation by ID or slug.

Signature

class Client {
  org: {
    get(idOrSlug: string): Promise<{ org: OrgResponse }>
  }
}

Parameters

NameTypeRequiredNotes
idOrSlug
stringyesOrganisation ID or slug

Throws

ErrorCondition
NotFoundError
Organisation not found

Examples

const { org } = await bf.org.get('acme-corp')
console.log(org.name)

Pitfalls

  • Slug vs ID — pass either the slug or the organisation ID; slugs are unique per tenant

See also

{auto-injected}

Tested against

{auto-injected}