Quick Links

Definition List

A semantic list of term-description pairs for presenting metadata or key-value information.

200: Successful request.
400: The request was not acceptable, often indicates the parameters were not correct.
401: The API key used was invalid.
403: The API key used did not have the correct permissions.
404: The resource was not found.
5xx: Indicates an error with WorkOS servers.

 <DefinitionList.Root>
  <DefinitionList.Item>
    <DefinitionList.Term>
      <Badge color="green">
        <Code variant="ghost">200</Code>
      </Badge>
    </DefinitionList.Term>
    <DefinitionList.Details>Successful request.</DefinitionList.Details>
  </DefinitionList.Item>

  <DefinitionList.Item>
    <DefinitionList.Term>
      <Badge color="yellow">
        <Code variant="ghost">400</Code>
      </Badge>
    </DefinitionList.Term>
    <DefinitionList.Details>
      The request was not acceptable, often indicates the parameters were not
      correct.
    </DefinitionList.Details>
  </DefinitionList.Item>

  <DefinitionList.Item>
    <DefinitionList.Term>
      <Badge color="yellow">
        <Code variant="ghost">401</Code>
      </Badge>
    </DefinitionList.Term>
    <DefinitionList.Details>
      The API key used was invalid.
    </DefinitionList.Details>
  </DefinitionList.Item>

  <DefinitionList.Item>
    <DefinitionList.Term>
      <Badge color="yellow">
        <Code variant="ghost">403</Code>
      </Badge>
    </DefinitionList.Term>
    <DefinitionList.Details>
      The API key used did not have the correct permissions.
    </DefinitionList.Details>
  </DefinitionList.Item>

  <DefinitionList.Item>
    <DefinitionList.Term>
      <Badge color="yellow">
        <Code variant="ghost">404</Code>
      </Badge>
    </DefinitionList.Term>
    <DefinitionList.Details>The resource was not found.</DefinitionList.Details>
  </DefinitionList.Item>

  <DefinitionList.Item>
    <DefinitionList.Term>
      <Badge color="red">
        <Code variant="ghost">5xx</Code>
      </Badge>
    </DefinitionList.Term>
    <DefinitionList.Details>
      Indicates an error with WorkOS servers.
    </DefinitionList.Details>
  </DefinitionList.Item>
</DefinitionList.Root>

API Reference

This component is based on the semantic HTML <dl> element and supports common margin props m, mx, my, ml, mr, mt, mb. View source

Root

The main container for the definition list. Maps to the HTML <dl> element.

Item

A wrapper for a term-details pair. Maps to a <div> element that contains both a term and its corresponding details.

Term

Defines a term in a definition list. Maps to the HTML <dt> element.

Details

Provides the definition/description for the preceding term. Maps to the HTML <dd> element.