Florality

GET

/api/v1/friends/{friendUserId}/front/history/month

friends: read1,000 requests/minute/key · all plans

Active API keys: Free 1, Pro 5, Pro+ 5. The request rate is the same on every plan.

Parameters

Path parameters

Name	Type	Required	Description
`friendUserId`	`string (uuid)`	Required	Identifier of the friend user.

Query parameters

Name	Type	Required	Description
`startTime`	`integer`	Required	Filter or option: start time.
`endTime`	`integer`	Required	Filter or option: end time.
`maxSessions`	`integer`	Optional	Filter or option: max sessions. Minimum: 1. Maximum: 50000.

Response schema

200

Successful response.

Name	Type	Required	Description
`items`	`array<object>`	Required	Items returned by this request.
`items[].session`	`object`	Required	Session.
`items[].session._id`	`string`	Required	Unique identifier.
`items[].session.userId`	`string`	Required	Owning account identifier.
`items[].session.memberId`	`string`	Required	Associated member identifier.
`items[].session.sideSystemId`	`null \| string`	Required	Side System Id.
`items[].session.subSystemId`	`null \| string`	Required	Sub System Id.
`items[].session.startedAt`	`number`	Required	Started At.
`items[].session.endedAt`	`number`	Optional	Ended At.
`items[].session.note`	`string`	Optional	Note.
`items[].session.createdBy`	`string`	Optional	Created By.
`items[].session.createdManually`	`boolean`	Optional	Created Manually. Allowed values: false, true.
`items[].session.editedAt`	`number`	Optional	Edited At.
`items[].session.editedManually`	`boolean`	Optional	Edited Manually. Allowed values: false, true.
`items[].session.typeKey`	`null \| string`	Optional	Type Key.
`items[].member`	`null \| object`	Required	Member.
`items[].member.id`	`string`	Required	Unique identifier.
`items[].member.name`	`string`	Required	Name of the resource.
`items[].member.displayName`	`string`	Optional	Display name.
`items[].member.archived`	`boolean`	Required	Archived.
`items[].member.avatarUrl`	`string`	Optional	Resolved avatar URL, or null when unavailable.
`items[].member.profileStyle`	`null \| object`	Optional	Profile presentation settings.
`items[].durationMs`	`null \| number`	Required	Duration Ms.
`truncated`	`boolean`	Required	Truncated.
`maxSessions`	`number`	Required	Max Sessions.
`nextCursor`	`null \| object`	Required	Cursor for the next page; null when there are no further results.
`nextCursor.startedAt`	`number`	Required	Started At.
`nextCursor.id`	`string`	Required	Unique identifier.

Errors

400 · JSON error: Missing friend user id.
401 · JSON error: Missing or invalid API key. Use Authorization: Bearer <token>.
403 · JSON error: Requires friends: read; ownership or feature restrictions may also deny access.
404 · JSON error: Request failed (NOT_FOUND).
409 · JSON error: Request failed (CONFLICT).
429 · JSON error: API rate limit exceeded (1000 requests per minute). Retry shortly.

Request example

Set FLORALITY_KEY in your environment. These examples use demo identifiers.

Shell

curl --request GET 'https://floralitys.com/api/v1/friends/11111111-1111-4111-8111-111111111111/front/history/month?startTime=1767225600000&endTime=1767225600000' \
  --header "Authorization: Bearer $FLORALITY_KEY"

Responses

Successful response.

JSON

{
  "items": [
    {
      "session": {
        "_id": "11111111-1111-4111-8111-111111111111",
        "userId": "11111111-1111-4111-8111-111111111111",
        "memberId": "11111111-1111-4111-8111-111111111111",
        "sideSystemId": null,
        "subSystemId": null,
        "startedAt": 1767225600000,
        "endedAt": 1767225600000,
        "note": "demo",
        "createdBy": "demo",
        "createdManually": false,
        "editedAt": 1767225600000,
        "editedManually": false,
        "typeKey": null
      },
      "member": null,
      "durationMs": null
    }
  ],
  "truncated": false,
  "maxSessions": 0,
  "nextCursor": null
}

Example values are illustrative demo data.

GET

/api/v1/friends/{friendUserId}/front/history/month

friends: read1,000 requests/minute/key · all plans

Active API keys: Free 1, Pro 5, Pro+ 5. The request rate is the same on every plan.

Parameters

Path parameters

Name	Type	Required	Description
`friendUserId`	`string (uuid)`	Required	Identifier of the friend user.

Query parameters

Name	Type	Required	Description
`startTime`	`integer`	Required	Filter or option: start time.
`endTime`	`integer`	Required	Filter or option: end time.
`maxSessions`	`integer`	Optional	Filter or option: max sessions. Minimum: 1. Maximum: 50000.

Response schema

200

Successful response.

Name	Type	Required	Description
`items`	`array<object>`	Required	Items returned by this request.
`items[].session`	`object`	Required	Session.
`items[].session._id`	`string`	Required	Unique identifier.
`items[].session.userId`	`string`	Required	Owning account identifier.
`items[].session.memberId`	`string`	Required	Associated member identifier.
`items[].session.sideSystemId`	`null \| string`	Required	Side System Id.
`items[].session.subSystemId`	`null \| string`	Required	Sub System Id.
`items[].session.startedAt`	`number`	Required	Started At.
`items[].session.endedAt`	`number`	Optional	Ended At.
`items[].session.note`	`string`	Optional	Note.
`items[].session.createdBy`	`string`	Optional	Created By.
`items[].session.createdManually`	`boolean`	Optional	Created Manually. Allowed values: false, true.
`items[].session.editedAt`	`number`	Optional	Edited At.
`items[].session.editedManually`	`boolean`	Optional	Edited Manually. Allowed values: false, true.
`items[].session.typeKey`	`null \| string`	Optional	Type Key.
`items[].member`	`null \| object`	Required	Member.
`items[].member.id`	`string`	Required	Unique identifier.
`items[].member.name`	`string`	Required	Name of the resource.
`items[].member.displayName`	`string`	Optional	Display name.
`items[].member.archived`	`boolean`	Required	Archived.
`items[].member.avatarUrl`	`string`	Optional	Resolved avatar URL, or null when unavailable.
`items[].member.profileStyle`	`null \| object`	Optional	Profile presentation settings.
`items[].durationMs`	`null \| number`	Required	Duration Ms.
`truncated`	`boolean`	Required	Truncated.
`maxSessions`	`number`	Required	Max Sessions.
`nextCursor`	`null \| object`	Required	Cursor for the next page; null when there are no further results.
`nextCursor.startedAt`	`number`	Required	Started At.
`nextCursor.id`	`string`	Required	Unique identifier.

Errors

400 · JSON error: Missing friend user id.
401 · JSON error: Missing or invalid API key. Use Authorization: Bearer <token>.
403 · JSON error: Requires friends: read; ownership or feature restrictions may also deny access.
404 · JSON error: Request failed (NOT_FOUND).
409 · JSON error: Request failed (CONFLICT).
429 · JSON error: API rate limit exceeded (1000 requests per minute). Retry shortly.

Request example

Set FLORALITY_KEY in your environment. These examples use demo identifiers.

Shell

curl --request GET 'https://floralitys.com/api/v1/friends/11111111-1111-4111-8111-111111111111/front/history/month?startTime=1767225600000&endTime=1767225600000' \
  --header "Authorization: Bearer $FLORALITY_KEY"

Responses

Successful response.

JSON

{
  "items": [
    {
      "session": {
        "_id": "11111111-1111-4111-8111-111111111111",
        "userId": "11111111-1111-4111-8111-111111111111",
        "memberId": "11111111-1111-4111-8111-111111111111",
        "sideSystemId": null,
        "subSystemId": null,
        "startedAt": 1767225600000,
        "endedAt": 1767225600000,
        "note": "demo",
        "createdBy": "demo",
        "createdManually": false,
        "editedAt": 1767225600000,
        "editedManually": false,
        "typeKey": null
      },
      "member": null,
      "durationMs": null
    }
  ],
  "truncated": false,
  "maxSessions": 0,
  "nextCursor": null
}

Example values are illustrative demo data.

Get friend front history month

Parameters

Path parameters

Query parameters

Response schema

200

Errors

Request example

Responses

Get friend front history month

Parameters

Path parameters

Query parameters

Response schema

200

Errors

Request example

Responses