# Envoy

> Manage workplace visitors and invitations, and read employees, locations and sign-in flows.

App · 15 actions. Web page: https://docs.lodol.com/docs/integrations/envoy

## Actions

### Create entry

Create an Entry.

**Inputs**

- Location (`location_id`, text, required): The locationId for the location that you are creating the entry at. You can find this by using the GET locations endpoint.
- Flow (`flow_id`, text, required): The sign-in flowId you want to use for the entry you are creating. You can find the flowIds by using the GET flows endpoint.
- Full name (`full_name`, text, required): The name that will be associated with the entry being created.
- Email (`email`, text): The email that will be associated with the entry being created.
- Signed in at (`signed_in_at`, date and time): If provided, this will set when the visitor signed in. Must be provided in ISO 8601 format (e.g., 2024-11-03T10:00:00Z). Defaults to current time if not provided.
- Photo base64 (`photo_base64`, text): If provided this will update the photo data attribute on the entry. Base64 encoded photo data.
- Print badge (`print_badge`, true/false): If true, triggers badge printing for this entry (if a printer is configured). Defaults to false. Default: `false`.
- Notify host (`notify_host`, true/false): If true, sends a notification to the host employee. Defaults to false. Note: For employee screening flows, this is always treated as false regardless of the value provided. Default: `false`.
- Custom fields (`custom_fields`, list): An array of custom field responses that correspond to the sign-in fields configured in the flow. Use this to set fields like Host (employee name), Company Name, Purpose of visit, etc.

**Outputs**

- `data` (object): Service response.

**Example output**

```json
{
  "data": {
    "data": {
      "agreementsStatus": "NOT_APPLICABLE",
      "customFields": "example",
      "email": "example",
      "flowId": "example",
      "fullName": "example",
      "host": "example",
      "id": "example",
      "invite": "example",
      "isDelivery": "example",
      "locationId": "example",
      "nda": "example",
      "notes": "example",
      "photo": "example",
      "signedInAt": "2026-11-01T12:00:00Z",
      "signedInBy": "example",
      "signedInVia": "example",
      "signedOutAt": "2026-11-01T12:00:00Z",
      "signedOutBy": "example",
      "signedOutVia": "example"
    },
    "meta": {
      "messages": [],
      "relationships": []
    }
  }
}
```

### Create invite

Create an Invite.

**Inputs**

- Invite id (`invite_id`, text): The id you would like assigned to the invite. If one is not provided we will automatically generate one.
- Expected arrival at (`expected_arrival_at`, date and time, required): The time (UTC) that the invitee is expected to arrive at.
- Expected departure at (`expected_departure_at`, date and time): The time (UTC) that the invitee is expected to depart at.
- Name (`name`, text, required): The name of the invitee.
- Email (`email`, text): The email of the invitee.
- Location (`location_id`, text, required): The id for the location that you want associated with the invite. You can find locationIds by using the GET locations endpoint.
- Flow (`flow_id`, text): The id for the flow you want associated with the invite. You can find flowIds by using the GET flows endpoint.
- Notes (`notes`, text): Internal notes that you want associated to the invite.
- Send email to invitee (`send_email_to_invitee`, true/false): Determines if the invite is sent to the invitee when an email is provided.
- Host employee (`host_employee_id`, text): If you would like an internal host to be associated with the invite, include their employeeId here. EmployeeIds can be found by using the GET employees endpoint.
- Custom fields (`custom_fields`, list): 'Any of the custom questions in the flow attached to the invite, along with the invitee's answers to those questions. Providing these for a new invite will pre-populate the answers. These must match exactly with the flow's sign-in fields, and one of them must be "Purpose of visit" with the flow name as the answer.'
- Photo base64 (`photo_base64`, text): Base64 encoded photo data.
- Invitation type (`type`, text, required): The invitation type. One of: `VISITOR`, `EMPLOYEE`.

**Outputs**

- `data` (object): Service response.

**Example output**

```json
{
  "data": {
    "data": {
      "approvalStatus": "PENDING",
      "createdAt": "2026-11-01T12:00:00Z",
      "customFields": "example",
      "expectedArrivalAt": "2026-11-01T12:00:00Z",
      "expectedDepartureAt": "2026-11-01T12:00:00Z",
      "flowId": "example",
      "host": "example",
      "id": "example",
      "invitee": "example",
      "locationId": "example",
      "notes": "example",
      "photoUrl": "example",
      "secretToken": "example",
      "sendEmailToInvitee": "example",
      "type": "example",
      "updatedAt": "2026-11-01T12:00:00Z"
    },
    "meta": {
      "messages": [],
      "relationships": []
    }
  }
}
```

### Get company

Get a company.

**Inputs**: None.

**Outputs**

- `data` (object): Service response.

**Example output**

```json
{
  "data": {
    "data": [],
    "meta": {
      "messages": [],
      "relationships": []
    }
  }
}
```

### Get employee

Look up an Employee by ID.

**Inputs**

- Id (`id`, text, required): Id.

**Outputs**

- `data` (object): Service response.

**Example output**

```json
{
  "data": {}
}
```

### Get entry

Get an Entry by ID.

**Inputs**

- Id (`id`, text, required): Id.

**Outputs**

- `data` (object): Service response.

**Example output**

```json
{
  "data": {
    "data": {
      "agreementsStatus": "NOT_APPLICABLE",
      "customFields": "example",
      "email": "example",
      "flowId": "example",
      "fullName": "example",
      "host": "example",
      "id": "example",
      "invite": "example",
      "isDelivery": "example",
      "locationId": "example",
      "nda": "example",
      "notes": "example",
      "photo": "example",
      "signedInAt": "2026-11-01T12:00:00Z",
      "signedInBy": "example",
      "signedInVia": "example",
      "signedOutAt": "2026-11-01T12:00:00Z",
      "signedOutBy": "example",
      "signedOutVia": "example"
    },
    "meta": {
      "messages": [],
      "relationships": []
    }
  }
}
```

### Get flow

Look up a Flow by ID.

**Inputs**

- Id (`id`, text, required): The `ID` scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `"4"`) or integer (such as `4`) input value will be accepted as an ID.

**Outputs**

- `data` (object): Service response.

**Example output**

```json
{
  "data": {}
}
```

### Get invite

Get an Invite by ID.

**Inputs**

- Id (`id`, text, required): The `ID` scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `"4"`) or integer (such as `4`) input value will be accepted as an ID.

**Outputs**

- `data` (object): Service response.

**Example output**

```json
{
  "data": {
    "data": {
      "approvalStatus": "PENDING",
      "createdAt": "2026-11-01T12:00:00Z",
      "customFields": "example",
      "expectedArrivalAt": "2026-11-01T12:00:00Z",
      "expectedDepartureAt": "2026-11-01T12:00:00Z",
      "flowId": "example",
      "host": "example",
      "id": "example",
      "invitee": "example",
      "locationId": "example",
      "notes": "example",
      "photoUrl": "example",
      "secretToken": "example",
      "sendEmailToInvitee": "example",
      "type": "example",
      "updatedAt": "2026-11-01T12:00:00Z"
    },
    "meta": {
      "messages": [],
      "relationships": []
    }
  }
}
```

### Get location

Get a location.

**Inputs**

- Id (`id`, text, required): Id.

**Outputs**

- `data` (object): Service response.

**Example output**

```json
{
  "data": {
    "data": {
      "address": {
        "city": "example",
        "country": "example",
        "latitude": 1.0,
        "line1": "example",
        "line2": "example",
        "longitude": 1.0,
        "postalCode": "example",
        "state": "example"
      },
      "capacityLimit": 1.0,
      "companyId": "example",
      "createdAt": "example",
      "enabled": "example",
      "id": "example",
      "locale": "example",
      "logoUrl": "example",
      "name": "example",
      "timezone": "example",
      "updatedAt": "example"
    },
    "meta": {
      "messages": [],
      "relationships": []
    }
  }
}
```

### List employees

Fetch a list of Employees.

**Inputs**

- Ids (`ids`, text): Ids.
- Name (`name`, text): The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
- Email (`email`, text): The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
- Page (`page`, number): Page number, starting at 1. From 1 to 100000.
- Per page (`per_page`, number): Page size, up to 100. From 1 to 100.
- Sort (`sort`, text): Sort. One of: `NAME`, `EMAIL`.
- Order (`order`, text): Order. One of: `ASC`, `DESC`.

**Outputs**

- `data` (object): Service response.

**Example output**

```json
{
  "data": {}
}
```

### List entries

Fetch a list of Entries.

**Inputs**

- Location ids (`location_ids`, text): Location ids.
- Signed in time after (`signed_in_at_after`, date and time): A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the `date-time` format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.
- Signed in time before (`signed_in_at_before`, date and time): A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the `date-time` format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.
- Email (`email`, text): The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
- Page (`page`, number): Page number, starting at 1. From 1 to 100000.
- Per page (`per_page`, number): Page size, up to 100. From 1 to 100.
- Sort (`sort`, text): Sort. One of: `CREATED_AT` (Created at), `SIGNED_IN_AT` (Signed in at).
- Order (`order`, text): Order. One of: `ASC`, `DESC`.

**Outputs**

- `data` (object): Service response.

**Example output**

```json
{
  "data": {
    "data": [],
    "meta": {
      "messages": [],
      "relationships": []
    }
  }
}
```

### List flows

Fetch a list of Flows.

**Inputs**

- Ids (`ids`, text): Ids.
- Enabled (`enabled`, text): The `Boolean` scalar type represents `true` or `false`.
- Name (`name`, text): The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
- Location ids (`location_ids`, text): Location ids.
- Type (`type`, text): Type. One of: `VISITOR`, `EMPLOYEE`.
- Page (`page`, number): Page number, starting at 1. From 1 to 100000.
- Per page (`per_page`, number): Page size, up to 100. From 1 to 100.
- Sort (`sort`, text): Sort. One of: `NAME`, `CREATED_AT` (Created at).
- Order (`order`, text): Order. One of: `ASC`, `DESC`.

**Outputs**

- `data` (object): Service response.

**Example output**

```json
{
  "data": {}
}
```

### List invites

Fetch a list of Invites.

**Inputs**

- Location ids (`location_ids`, text): Location ids.
- Expected arrival time before (`expected_arrival_at_before`, date and time): A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the `date-time` format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.
- Expected arrival time after (`expected_arrival_at_after`, date and time): A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the `date-time` format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.
- Created time before (`created_at_before`, date and time): A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the `date-time` format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.
- Created time after (`created_at_after`, date and time): A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the `date-time` format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.
- Host email (`host_email`, text): The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
- Invitee email (`invitee_email`, text): The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
- Type (`type`, text): Type. One of: `VISITOR`, `EMPLOYEE`.
- Approval status (`approval_status`, text): Approval status. One of: `PENDING`, `APPROVED`, `DENIED`, `AWAITING_REVIEW` (Awaiting review).
- Page (`page`, number): Page number, starting at 1. From 1 to 100000.
- Per page (`per_page`, number): Page size, up to 100. From 1 to 100.
- Sort (`sort`, text): Sort. One of: `EXPECTED_ARRIVAL_AT` (Expected arrival at), `CREATED_AT` (Created at).
- Order (`order`, text): Order. One of: `ASC`, `DESC`.

**Outputs**

- `data` (object): Service response.

**Example output**

```json
{
  "data": {
    "data": [],
    "meta": {
      "messages": [],
      "relationships": []
    }
  }
}
```

### List locations

Get locations.

**Inputs**

- Ids (`ids`, list): Ids.
- Created at after (`created_at_after`, text): Created at after.
- Created at before (`created_at_before`, text): Created at before.
- Sort (`sort`, text): Sort. One of: `createdAt`, `updatedAt`.
- Order (`order`, text): Order. One of: `ASC`, `DESC`.
- Enabled (`enabled`, true/false): Enabled.
- Page (`page`, number): Page number, starting at 1. From 1 to 100000.
- Per page (`per_page`, number): Page size, up to 100. From 1 to 100.

**Outputs**

- `data` (object): Service response.

**Example output**

```json
{
  "data": {
    "data": [],
    "meta": {
      "messages": [],
      "relationships": []
    }
  }
}
```

### Update entry

Update an Entry.

**Inputs**

- Id (`id`, text, required): Id.
- Full name (`full_name`, text): If provided this will update the full name attribute on the entry.
- Email (`email`, text): If provided this will update the email attribute on the entry.
- Signed out at (`signed_out_at`, date and time): If provided this will mark when the visitor signed out. Must be provided in ISO 8601 format (e.g., 2024-11-03T15:00:00Z).
- Location (`location_id`, text): If provided this will update the location associated with the entry.
- Flow (`flow_id`, text): If provided this will update the sign-in flow associated with the entry.
- Photo base64 (`photo_base64`, text): If provided this will update the photo data attribute on the entry. Base64 encoded photo data.
- Custom fields (`custom_fields`, list): An array of custom field responses that correspond to the sign-in fields configured in the flow. Use this to update fields like Host (employee name), Company Name, Purpose of visit, etc.

**Outputs**

- `data` (object): Service response.

**Example output**

```json
{
  "data": {
    "data": {
      "agreementsStatus": "NOT_APPLICABLE",
      "customFields": "example",
      "email": "example",
      "flowId": "example",
      "fullName": "example",
      "host": "example",
      "id": "example",
      "invite": "example",
      "isDelivery": "example",
      "locationId": "example",
      "nda": "example",
      "notes": "example",
      "photo": "example",
      "signedInAt": "2026-11-01T12:00:00Z",
      "signedInBy": "example",
      "signedInVia": "example",
      "signedOutAt": "2026-11-01T12:00:00Z",
      "signedOutBy": "example",
      "signedOutVia": "example"
    },
    "meta": {
      "messages": [],
      "relationships": []
    }
  }
}
```

### Update invite

Update an Invite.

**Inputs**

- Id (`id`, text, required): The `ID` scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `"4"`) or integer (such as `4`) input value will be accepted as an ID.
- Expected arrival at (`expected_arrival_at`, date and time): The time (UTC) that the invitee is expected to arrive at.
- Expected departure at (`expected_departure_at`, date and time): The time (UTC) that the invitee is expected to depart at.
- Name (`name`, text): The name of the invitee.
- Email (`email`, text): The email of the invitee.
- Location (`location_id`, text): The id for the location that you want associated with the invite. You can find locationIds by using the GET locations endpoint.
- Flow (`flow_id`, text): The id for the flow you want associated with the invite. You can find flowIds by using the GET flows endpoint.
- Notes (`notes`, text): Internal notes that you want associated to the invite.
- Host employee (`host_employee_id`, text): If you would like an internal host to be associated with the invite, include their employeeId here. EmployeeIds can be found by using the GET employees endpoint.
- Custom fields (`custom_fields`, list): 'Any of the custom questions in the flow attached to the invite, along with the invitee's answers to those questions. Providing these for a new invite will pre-populate the answers. These must match exactly with the flow's sign-in fields, and one of them must be "Purpose of visit" with the flow name as the answer.'
- Photo base64 (`photo_base64`, text): Base64 encoded photo data.
- Invitation type (`type`, text): The invitation type. One of: `VISITOR`, `EMPLOYEE`.

**Outputs**

- `data` (object): Service response.

**Example output**

```json
{
  "data": {
    "data": {
      "approvalStatus": "PENDING",
      "createdAt": "2026-11-01T12:00:00Z",
      "customFields": "example",
      "expectedArrivalAt": "2026-11-01T12:00:00Z",
      "expectedDepartureAt": "2026-11-01T12:00:00Z",
      "flowId": "example",
      "host": "example",
      "id": "example",
      "invitee": "example",
      "locationId": "example",
      "notes": "example",
      "photoUrl": "example",
      "secretToken": "example",
      "sendEmailToInvitee": "example",
      "type": "example",
      "updatedAt": "2026-11-01T12:00:00Z"
    },
    "meta": {
      "messages": [],
      "relationships": []
    }
  }
}
```
